/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wse.matching;

import java.util.Calendar;

import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.eventing.FilterType;

/** This class represents the entry corresponding to subscriptions, within
    the SubscriptionManagement.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.5 $
*/

public class SubscriptionEntry {
  private String identifier;
  private FilterType filter;
  private EndpointReferenceType source, sink, subscriptionManager, endTo;
  private Calendar expiresAt;
  private String moduleName = "SubscriptionEntry: ";


  protected SubscriptionEntry(String identifier,
			      FilterType filter, Calendar expiresAt,
			      EndpointReferenceType source,
			      EndpointReferenceType sink,
			      EndpointReferenceType endTo,
			      EndpointReferenceType subscriptionManager) {
    this.identifier = identifier;
    this.filter = filter;
    this.expiresAt = expiresAt;
    this.source = source;
    this.sink = sink;
    this.endTo = endTo;
    this.subscriptionManager=  subscriptionManager;
  }

  /** Gets the subscription identifier */
  public String getIdentifier() {
    return identifier;
  }


  /** Gets the Filter associated with this subscription Entry */
  public FilterType getFilter() {
    return filter;
  }


  /** Gets the expiry associated with this entry */
  public Calendar getExpiresAt() {
    return expiresAt;
  }

  /** Update the expiry field for this subscription entry */
  protected void updateExpiresAt(Calendar expiresAt) {
    this.expiresAt = expiresAt;
  }


  /** Check to see if this subscription has expired. This method returns
      true if the subscription has indeed expired.*/
  protected boolean isExpired(Calendar currentTime) {
    //Calendar currentTime = Calendar.getInstance();
    boolean isExpired = expiresAt.before(currentTime);
    return isExpired;
  }



  /** Gets the source at which this subscription was registered */
  public EndpointReferenceType getSource() {
    return source;
  }


  /** Gets the Sinks which registered this subscription */
  public EndpointReferenceType getSink() {
    return sink;
  }

  /** Gets the Sink's registered endTo for this subscription */
  public EndpointReferenceType getEndTo() {
    return endTo;
  }


  /** Checks to see if  the EndTo has been specified, so that we can send
      SubscriptionEnd's if the need arises. */
  public boolean hasEndTo() {
    if (endTo != null) {
      return true;
    }
    return false;
  }


  /** Gets the subscription manager for this subscription */
  public EndpointReferenceType getSubscriptionManager() {
    return subscriptionManager;
  }


}

